GET PlanCare2Api/ClientAppointments/ContractAppointments?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}&dateFrom={dateFrom}&dateUntil={dateUntil}

Obtains all contract appointments

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientIds

Identifiers of the clients

 Collection of integer

Required
dateFrom

Startdate of period

 date

Required
dateUntil

Enddate of period

 date

Required

Body Parameters

None.

Response Information

Resource Description

List of contract appointments

Collection of ContractAppointment
NameDescriptionTypeAdditional information
ContractId

The Id of the Contract.

 integer

Required
ProductId

The Id of the Product.

 integer

Required
ProductName

The name of the Product.

 string

None
ContractLineId

The Id of the ContractLine.

 integer

Deprecated (unavailable from 11.36): No longer in use. Will be removed in a future version of the API.
CareTrajectId

The Id of the CareTraject.

 integer

Conditional Required: Only required for PCDDBC contract appointments
DOTLocationId

The Id of the DOTLocation.

 integer

Conditional Required: Only required for GRZ contract appointments
WorkTypeId

The Id of the Worktype.

 integer

None
ProjectId

The Identifier of the Project. Consists of clientmutationId and projectDescription.

 string

Conditional Required: Only required for PCD and PCDDBC contract appointments
ProjectName

The name of the Project.

 string

None
OrganizationEntityId

Refers to the organization entity id.

 Identity

None
ClientId

The internal id of the client.

 integer

Required
ClientName

The name of the client.

 string

None
EmployeeId

The internal id of the employee who owns the appointment.

 integer

None
EmployeeName

The name of the employee who owns the appointment.

 string

None
EmploymentId

The internal id of the employment of the specified employee.

 integer

None
ContractOfServiceId

The internal id of the employment of the specified employee.

 integer

Deprecated (unavailable from 11.36): Please use 'EmploymentId' instead.
Start

The start date and time of the appointment.

 date

Required
End

The end date and time of the appointment.

 date

Required
Title

The subject of the appointment.

 string

Required
Reason

The given reason when the appointment is completed or cancelled.

 string

None
Status

Defines the status of the appointment. A Recurrence appointment will always have the status 'Created'.

 PlannedItemStatus

None
StatusChangedByName

The name of the employee who changed the status of the appointment.

 string

None
StatusChangedById

The id of the employee who changed the status of the appointment.

 integer

None
CreatedByName

The name of the employee who created the appointment.

 string

None
CreatedById

The id of the employee who created the appointment.

 integer

None
Remarks

Remarks made to the appointment.

 string

None
Id

The internal id of the appointment.

 integer

Conditional Required: Only required for existing appointments
Location

The location of the appointment.

 string

None
MovesToNextDay

Determines whether the appointment will be moved to the next day when not completed.

 boolean

Required
IsAllDay

Is the appointment created as an all-day appointment.

 boolean

Required
FriendlyRecurrenceInfo

The user friendly description of the recurrence for the appointment. This description is readonly. Only set when type is Recurrence.

 string

None
RecurrenceInfo

Defines the recurrence for the appointment. Only set when type is Recurrence. When creating a appointment the RecurrenceStart property of RecurrenceInfo must be equal to the Start property. Can be left empty if you want to remove the recurrence.

 RecurrenceInfo

None
RecurrenceOccurrences

The list of occurrences if the appointment is recurrent. Only occurrences within the provided range are returned. Only set when type is Recurrence.

 Collection of OccurrenceAppointment

None
Type

Defines the type of the appointment, default type is normal.

 AppointmentType

None
ShiftId

The Id of the Shift.

 integer

None
ContractInfo

The appointment ContractInfo.

 string

None
WeekPlanningId

The Id of the WeekPlanning.

 integer

None

Response Formats

application/json, text/json

Sample: 
[
  {
    "$id": "1",
    "ContractId": 1,
    "ProductId": 2,
    "ProductName": "sample string 3",
    "ContractLineId": 1,
    "CareTrajectId": 1,
    "DOTLocationId": 1,
    "WorkTypeId": 1,
    "ProjectId": "sample string 4",
    "ProjectName": "sample string 5",
    "OrganizationEntityId": {
      "$id": "2",
      "Identifier": "sample string 1",
      "Type": 0
    },
    "ClientId": 6,
    "ClientName": "sample string 7",
    "EmployeeId": 1,
    "EmployeeName": "sample string 8",
    "EmploymentId": 1,
    "ContractOfServiceId": 1,
    "Start": "2026-05-26T21:11:19.1855351+02:00",
    "End": "2026-05-26T21:11:19.1855351+02:00",
    "Title": "sample string 11",
    "Reason": "sample string 12",
    "Status": 0,
    "StatusChangedByName": "sample string 13",
    "StatusChangedById": 14,
    "CreatedByName": "sample string 15",
    "CreatedById": 16,
    "Remarks": "sample string 17",
    "Id": 18,
    "Location": "sample string 19",
    "MovesToNextDay": true,
    "IsAllDay": true,
    "FriendlyRecurrenceInfo": "sample string 22",
    "RecurrenceInfo": {
      "$id": "3",
      "OccurrenceCount": 1,
      "Periodicity": 1,
      "Range": 0,
      "Interval": 0,
      "WeekDays": 1,
      "RecurrenceStart": "2026-05-26T21:11:19.1855351+02:00",
      "RecurrenceEnd": "2026-05-26T21:11:19.1855351+02:00",
      "Month": 1,
      "DayNumber": 1,
      "WeekOfMonth": 0
    },
    "RecurrenceOccurrences": [
      {
        "$id": "4",
        "Id": 1,
        "Start": "2026-05-26T21:11:19.1855351+02:00",
        "End": "2026-05-26T21:11:19.1855351+02:00",
        "Title": "sample string 4",
        "Location": "sample string 5",
        "ParentId": 6,
        "OccurrenceIndex": 7,
        "Type": 0,
        "Reason": "sample string 8",
        "Status": 0,
        "StatusChangedByName": "sample string 9",
        "StatusChangedById": 10,
        "CreatedByName": "sample string 11",
        "CreatedById": 12,
        "Remarks": "sample string 13"
      },
      {
        "$ref": "4"
      }
    ],
    "Type": 0,
    "ShiftId": 1,
    "ContractInfo": "sample string 23",
    "WeekPlanningId": 1
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfContractAppointment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar.Client">
  <ContractAppointment>
    <ContractInfo xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 23</ContractInfo>
    <CreatedById xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">16</CreatedById>
    <CreatedByName xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 15</CreatedByName>
    <End xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">2026-05-26T21:11:19.1855351+02:00</End>
    <FriendlyRecurrenceInfo xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 22</FriendlyRecurrenceInfo>
    <Id xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">18</Id>
    <IsAllDay xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">true</IsAllDay>
    <Location xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 19</Location>
    <MovesToNextDay xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">true</MovesToNextDay>
    <Reason xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 12</Reason>
    <RecurrenceInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar.Recurrence" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">
      <d3p1:DayNumber>1</d3p1:DayNumber>
      <d3p1:Interval>Daily</d3p1:Interval>
      <d3p1:Month>1</d3p1:Month>
      <d3p1:OccurrenceCount>1</d3p1:OccurrenceCount>
      <d3p1:Periodicity>1</d3p1:Periodicity>
      <d3p1:Range>NoEndDate</d3p1:Range>
      <d3p1:RecurrenceEnd>2026-05-26T21:11:19.1855351+02:00</d3p1:RecurrenceEnd>
      <d3p1:RecurrenceStart>2026-05-26T21:11:19.1855351+02:00</d3p1:RecurrenceStart>
      <d3p1:WeekDays>Sunday</d3p1:WeekDays>
      <d3p1:WeekOfMonth>None</d3p1:WeekOfMonth>
    </RecurrenceInfo>
    <RecurrenceOccurrences xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">
      <OccurrenceAppointment>
        <CreatedById>12</CreatedById>
        <CreatedByName>sample string 11</CreatedByName>
        <End>2026-05-26T21:11:19.1855351+02:00</End>
        <Id>1</Id>
        <Location>sample string 5</Location>
        <OccurrenceIndex>7</OccurrenceIndex>
        <ParentId>6</ParentId>
        <Reason>sample string 8</Reason>
        <Remarks>sample string 13</Remarks>
        <Start>2026-05-26T21:11:19.1855351+02:00</Start>
        <Status>Created</Status>
        <StatusChangedById>10</StatusChangedById>
        <StatusChangedByName>sample string 9</StatusChangedByName>
        <Title>sample string 4</Title>
        <Type>Occurrence</Type>
      </OccurrenceAppointment>
      <OccurrenceAppointment>
        <CreatedById>12</CreatedById>
        <CreatedByName>sample string 11</CreatedByName>
        <End>2026-05-26T21:11:19.1855351+02:00</End>
        <Id>1</Id>
        <Location>sample string 5</Location>
        <OccurrenceIndex>7</OccurrenceIndex>
        <ParentId>6</ParentId>
        <Reason>sample string 8</Reason>
        <Remarks>sample string 13</Remarks>
        <Start>2026-05-26T21:11:19.1855351+02:00</Start>
        <Status>Created</Status>
        <StatusChangedById>10</StatusChangedById>
        <StatusChangedByName>sample string 9</StatusChangedByName>
        <Title>sample string 4</Title>
        <Type>Occurrence</Type>
      </OccurrenceAppointment>
    </RecurrenceOccurrences>
    <Remarks xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 17</Remarks>
    <ShiftId xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">1</ShiftId>
    <Start xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">2026-05-26T21:11:19.1855351+02:00</Start>
    <Status xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">Created</Status>
    <StatusChangedById xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">14</StatusChangedById>
    <StatusChangedByName xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 13</StatusChangedByName>
    <Title xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 11</Title>
    <Type xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">Normal</Type>
    <WeekPlanningId xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">1</WeekPlanningId>
    <ClientId>6</ClientId>
    <ClientName>sample string 7</ClientName>
    <ContractOfServiceId>1</ContractOfServiceId>
    <EmployeeId>1</EmployeeId>
    <EmployeeName>sample string 8</EmployeeName>
    <EmploymentId>1</EmploymentId>
    <CareTrajectId>1</CareTrajectId>
    <ContractId>1</ContractId>
    <ContractLineId>1</ContractLineId>
    <DOTLocationId>1</DOTLocationId>
    <OrganizationEntityId xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
      <d3p1:Identifier>sample string 1</d3p1:Identifier>
      <d3p1:Type>ExternalId</d3p1:Type>
    </OrganizationEntityId>
    <ProductId>2</ProductId>
    <ProductName>sample string 3</ProductName>
    <ProjectId>sample string 4</ProjectId>
    <ProjectName>sample string 5</ProjectName>
    <WorkTypeId>1</WorkTypeId>
  </ContractAppointment>
  <ContractAppointment>
    <ContractInfo xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 23</ContractInfo>
    <CreatedById xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">16</CreatedById>
    <CreatedByName xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 15</CreatedByName>
    <End xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">2026-05-26T21:11:19.1855351+02:00</End>
    <FriendlyRecurrenceInfo xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 22</FriendlyRecurrenceInfo>
    <Id xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">18</Id>
    <IsAllDay xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">true</IsAllDay>
    <Location xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 19</Location>
    <MovesToNextDay xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">true</MovesToNextDay>
    <Reason xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 12</Reason>
    <RecurrenceInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar.Recurrence" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">
      <d3p1:DayNumber>1</d3p1:DayNumber>
      <d3p1:Interval>Daily</d3p1:Interval>
      <d3p1:Month>1</d3p1:Month>
      <d3p1:OccurrenceCount>1</d3p1:OccurrenceCount>
      <d3p1:Periodicity>1</d3p1:Periodicity>
      <d3p1:Range>NoEndDate</d3p1:Range>
      <d3p1:RecurrenceEnd>2026-05-26T21:11:19.1855351+02:00</d3p1:RecurrenceEnd>
      <d3p1:RecurrenceStart>2026-05-26T21:11:19.1855351+02:00</d3p1:RecurrenceStart>
      <d3p1:WeekDays>Sunday</d3p1:WeekDays>
      <d3p1:WeekOfMonth>None</d3p1:WeekOfMonth>
    </RecurrenceInfo>
    <RecurrenceOccurrences xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">
      <OccurrenceAppointment>
        <CreatedById>12</CreatedById>
        <CreatedByName>sample string 11</CreatedByName>
        <End>2026-05-26T21:11:19.1855351+02:00</End>
        <Id>1</Id>
        <Location>sample string 5</Location>
        <OccurrenceIndex>7</OccurrenceIndex>
        <ParentId>6</ParentId>
        <Reason>sample string 8</Reason>
        <Remarks>sample string 13</Remarks>
        <Start>2026-05-26T21:11:19.1855351+02:00</Start>
        <Status>Created</Status>
        <StatusChangedById>10</StatusChangedById>
        <StatusChangedByName>sample string 9</StatusChangedByName>
        <Title>sample string 4</Title>
        <Type>Occurrence</Type>
      </OccurrenceAppointment>
      <OccurrenceAppointment>
        <CreatedById>12</CreatedById>
        <CreatedByName>sample string 11</CreatedByName>
        <End>2026-05-26T21:11:19.1855351+02:00</End>
        <Id>1</Id>
        <Location>sample string 5</Location>
        <OccurrenceIndex>7</OccurrenceIndex>
        <ParentId>6</ParentId>
        <Reason>sample string 8</Reason>
        <Remarks>sample string 13</Remarks>
        <Start>2026-05-26T21:11:19.1855351+02:00</Start>
        <Status>Created</Status>
        <StatusChangedById>10</StatusChangedById>
        <StatusChangedByName>sample string 9</StatusChangedByName>
        <Title>sample string 4</Title>
        <Type>Occurrence</Type>
      </OccurrenceAppointment>
    </RecurrenceOccurrences>
    <Remarks xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 17</Remarks>
    <ShiftId xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">1</ShiftId>
    <Start xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">2026-05-26T21:11:19.1855351+02:00</Start>
    <Status xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">Created</Status>
    <StatusChangedById xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">14</StatusChangedById>
    <StatusChangedByName xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 13</StatusChangedByName>
    <Title xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">sample string 11</Title>
    <Type xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">Normal</Type>
    <WeekPlanningId xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Calendar">1</WeekPlanningId>
    <ClientId>6</ClientId>
    <ClientName>sample string 7</ClientName>
    <ContractOfServiceId>1</ContractOfServiceId>
    <EmployeeId>1</EmployeeId>
    <EmployeeName>sample string 8</EmployeeName>
    <EmploymentId>1</EmploymentId>
    <CareTrajectId>1</CareTrajectId>
    <ContractId>1</ContractId>
    <ContractLineId>1</ContractLineId>
    <DOTLocationId>1</DOTLocationId>
    <OrganizationEntityId xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
      <d3p1:Identifier>sample string 1</d3p1:Identifier>
      <d3p1:Type>ExternalId</d3p1:Type>
    </OrganizationEntityId>
    <ProductId>2</ProductId>
    <ProductName>sample string 3</ProductName>
    <ProjectId>sample string 4</ProjectId>
    <ProjectName>sample string 5</ProjectName>
    <WorkTypeId>1</WorkTypeId>
  </ContractAppointment>
</ArrayOfContractAppointment>